Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop lock files and their handling in the package system #370

Merged
merged 28 commits into from
Nov 3, 2022

Conversation

gfngfn
Copy link
Owner

@gfngfn gfngfn commented Oct 29, 2022

Every document file foo.saty must have a lock config file foo.satysfi-lock at the same directory. The contents of lock config files must be of the form LockConfig defined as follows:

LockConfig := {
  locks: Array[Lock],
}

Lock := {
  name: LockName,
    // The name of the locked package (e.g. "stdlib.0.0.1").
    // This name need not consist of the (non-locked) package name and version information.
  location: GlobalLockLocation | …,
    // How to access the locked package.
  dependencies: Array[LockName],
}

LockName := String

GlobalLockLocation := {
  type: "global",
  path: String,
    // The relative path to the directory containing package.yaml seen from the SATySFi library root.
    // (e.g. "packages/stdlib/stdlib.0.0.1/")
}

Every locked package must have a package config file satysfi.yaml at its root directory. Its contents must be of the form PackageConfig defined as follows:

PackageConfig := {
  language: String,
    // A SATySFi version required by the locked package (e.g. "0.1.0")
  contents: Library | Document | …,
    // How to access files such as sources provided by the package.
}

Library := {
  type: "library",
  source_directories: Array[String],  # e.g. [ "./src" ]
  main_module: String,
}

Document := {
  type: "document",
  file: String,
}

@gfngfn gfngfn changed the title [WIP] Develop lock files and their handling in the package system Develop lock files and their handling in the package system Oct 29, 2022
@gfngfn gfngfn marked this pull request as ready for review October 29, 2022 20:49
@gfngfn gfngfn merged commit 04eefc8 into dev-0-1-0-package-system Nov 3, 2022
@gfngfn gfngfn deleted the dev-0-1-0-lock-file branch April 7, 2024 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant